Repository navigation
Launch-grade README and repository hygiene - #8
Merged
Merged
Conversation
…ns, verify, runs, MCP, async, errors, configuration, status Signed-off-by: Sahil Jagtap <sahil.jagtap45@gmail.com>
…ue and PR templates, dependabot Signed-off-by: Sahil Jagtap <sahil.jagtap45@gmail.com>
…t-release wording Signed-off-by: Sahil Jagtap <sahil.jagtap45@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
README.mdrewritten to the launch layout: centered logo (light variant for dark mode) and badges (PyPI, Python versions, licence, CI, release, docs), links row, what it is, install, a quickstart that connects, creates, screenshots, clicks, runs a shell action, verifies and destroys, a Mermaid diagram, then sections for computers, actions, verify and thetrustedflag, runs, MCP (hosted and local, theconfirm: truerule, the HTTPS-only transport rule), the async client, an errors table, a configuration table, development, versioning, security, contributing, licence and status.SECURITY.md(supported versions, private reporting first through GitHub then security@drums.run, response times, what the SDK guarantees, the runtime's known limitations stated plainly),CODE_OF_CONDUCT.md(Contributor Covenant 2.1),CONTRIBUTING.mdwith DCO sign-off, issue templates (bug, feature, contact links), a pull request template anddependabot.yml(pip and GitHub Actions).ci.ymlruns the suite on 3.9, 3.10, 3.11, 3.12 and 3.13 (was 3.9, 3.12, 3.13), so the README's claim is literal.RELEASE.mddrops the first-release wording.docs/assets/drums-symbol.svganddrums-symbol-light.svg; the README references them by their raw URL onmain, so the logo shows once this merges.No code or packaging change; no version bump; the
v0.3.0tag is untouched.How it was tested
py_compiled on Python 3.9.tests/(no production key was available for this run):score 1 valid True [], 8 concurrent creates and verifies in the async example. The SDK was also pointed athttps://beta.drums.run/gwwith a placeholder key and raisedAuthError 401 unauthenticated, so the URL and transport rule in the README are right.drums version,drums --help,drums mcp --help,drums mcp --print-config claude|claude-local|cursor|codex(outputs pasted into the README),drums mcp --url http://...refused with exit 2, and a stdioinitialize+tools/listround trip (34 tools, three destructive).python -m unittest discover -s testson 3.9, 3.10, 3.11, 3.12 and 3.13 (76 tests each, OK);python -m buildandtwine check --strictpass with the new README as the long description.main, which resolve after merge (verified on this branch).